.TH "Zebulon::MicroStrain::ThreeDMGX2" 3 "13 Oct 2009" "Version 2" "zebulon" \" -*- nroff -*-
.ad l
.nh
.SH NAME
Zebulon::MicroStrain::ThreeDMGX2 \- 
.PP
Interface class for the \fBMicroStrain\fP 3DM-GX2 Orientation Sensor using RS232.  

.SH SYNOPSIS
.br
.PP
.PP
\fC#include <threedmgx2.h>\fP
.SS "Classes"

.in +1c
.ti -1c
.RI "class \fBCallback\fP"
.br
.RI "\fI\fBCallback\fP class to register for messages as the arrive on the serial port. \fP"
.in -1c
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBThreeDMGX2\fP (const unsigned int maxQueueSize=15)"
.br
.ti -1c
.RI "int \fBInitialize\fP (const std::string &port, const unsigned int ibaud=115200, const bool tryOtherBauds=true, const unsigned int timout=2000)"
.br
.ti -1c
.RI "int \fBShutdown\fP ()"
.br
.ti -1c
.RI "int \fBRegisterCallback\fP (\fBThreeDMGX2::Callback\fP *cb)"
.br
.ti -1c
.RI "int \fBRemoveCallback\fP (\fBThreeDMGX2::Callback\fP *cb)"
.br
.ti -1c
.RI "bool \fBIsConnected\fP () const "
.br
.ti -1c
.RI "bool \fBSetContinuousMode\fP (const Message::Type type)"
.br
.ti -1c
.RI "bool \fBTransmitMessage\fP (const CxUtils::Packet message, \fBMicroStrain::Message\fP **response, unsigned int timeout=1000)"
.br
.in -1c
.SS "Static Protected Member Functions"

.in +1c
.ti -1c
.RI "static void \fBReceiveThreadFunction\fP (void *args)"
.br
.in -1c
.SS "Protected Attributes"

.in +1c
.ti -1c
.RI "volatile bool \fBmConnectedFlag\fP"
.br
.RI "\fIFlag to indicate a connection has been made. \fP"
.ti -1c
.RI "CxUtils::Mutex \fBmTransmittingMutex\fP"
.br
.RI "\fIMutex to signal sending data. \fP"
.ti -1c
.RI "CxUtils::Mutex \fBmMessageQueueMutex\fP"
.br
.RI "\fIMutex for message queue. \fP"
.ti -1c
.RI "CxUtils::Mutex \fBmCallbackMutex\fP"
.br
.RI "\fIMutex for callbacks. \fP"
.ti -1c
.RI "CxUtils::Thread \fBmReceiveThread\fP"
.br
.RI "\fIThread for receiving data from sensor. \fP"
.ti -1c
.RI "CxUtils::Serial \fBmSerialPort\fP"
.br
.RI "\fISerial port interface. \fP"
.ti -1c
.RI "Message::Type \fBmContinuousModeType\fP"
.br
.RI "\fIType of continuous mode to maintain. \fP"
.ti -1c
.RI "Message::List \fBmMessageQueue\fP"
.br
.RI "\fIAll received messages. \fP"
.ti -1c
.RI "std::set< \fBThreeDMGX2::Callback\fP * > \fBmCallbacks\fP"
.br
.RI "\fISet of callbacks. \fP"
.ti -1c
.RI "unsigned int \fBmMaxQueueSize\fP"
.br
.RI "\fIMaximum number of messages to store. \fP"
.in -1c
.SS "Static Protected Attributes"

.in +1c
.ti -1c
.RI "static const unsigned char \fBGX2Confirm1\fP = 0xC1"
.br
.ti -1c
.RI "static const unsigned char \fBGX2Confirm2\fP = 0x29"
.br
.in -1c
.SH "Detailed Description"
.PP 
Interface class for the \fBMicroStrain\fP 3DM-GX2 Orientation Sensor using RS232. 

.SH "Author"
.PP 
Generated automatically by Doxygen for zebulon from the source code.
